Version: 5.2

TimeEntry Service

Dieser Service enthält Methoden um mit den Zeiteinträgen von TimePunch zu arbeiten.

AssignTimeEntriesToCustomer

Mit dieser Methode können mehrere Zeiteinträge einem neuen Kunden zugeordnet werden.

void AssignTimeEntriesToCustomer(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] timeEntryIds,  
 Guid customerId);

Needed Permission	timeEntries@restrictedEdit
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntryIds		Array of ids of the time entries that shall be amended.
customerId		New customer Id that is used to update the time entries.

AssignTimeEntriesToProjects

Mit dieser Methode können mehrere Zeiteinträge einem neuen Projekt zugeordnet werden.

void AssignTimeEntriesToProjects(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] timeEntryIds,  
 Guid projectId,  
 Guid taskId);

Needed Permission	timeEntries@restrictedEdit
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntryIds		Array of ids of the time entries that shall be amended.
projectId		New project Id that is used to update the time entries.
taskId		New task Id that is used to update the time entries.

BatchFilterUpdate

Diese Methode aktualisiert alle öffentlichen sowie privaten Filter in TimePunch.

TpFault BatchFilterUpdate(  
 TpAuthentication authentication,  
 List<TimeEntrySearchDto> privateFilters,  
 List<TimeEntrySearchDto> publicFilters);

Needed Permission	timeEntryFilter@manage
Name	Modifier	Description
authentication		User authentication
privateFilters		Collection of private filters
publicFilters		Collection of public filters
Return value		Fault object if an exception occurs

CheckTimeEntryOverlapping

Diese Methode prüft, ob der übergebene Zeiteintrag bestehende Zeiteinträge beim Speichern überschreiben würde. Damit kann ein ungewolltes überschreiben von Zeiteinträgen verhindert werden.

bool CheckTimeEntryOverlapping(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntryDto entryToCheckOverlapping);

Needed Permission	timeEntries@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
entryToCheckOverlapping		Time Entry that shall be checked against the existing time entries in the database.
Return value		Returns true, if the given time entry would harm existing time entries.

CopyTimeEntries

Diese Methode kopiert eine Liste mit Zeiteinträgen und setzt sie an dem übergebenen Datum wieder ein.

void CopyTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<TimeEntrySaveDto> entriesToCopy,  
 DateTime insertAt);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
entriesToCopy		List of time entries to copy
insertAt		Date from that the time entries shall be inserted.

CreateBreakTimeDummy

Diese Methode erzeugt einen Pausenzeiteintrag. Ein Pausenzeiteintrag wird immer dann benötigt, wenn eine Zeitspanne zwischen dem letzten Zeiteintrag und dem folgenden Zeiteintrag liegt.

TimeEntryDto CreateBreakTimeDummy(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime startBreak,  
 DateTime endBreak);

Needed Permission	timeEntries@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
startBreak		Start time of the dummy break entry
endBreak		End time of the dummy break entry.
Return value		The created time entry

CreateNewTimeEntry

Diese Methode erzeugt einen neuen Zeiteintrag und liefert ihn zurück. Der Zeiteintrag wird dabei erzeugt, nicht gespeichert. Erst nach dem Aufruf der Speichermethode ist der Eintrag im TimePunch Profil verfügbar.

TimeEntryDto CreateNewTimeEntry(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime date);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
date		Date that shall be used for creating the new time entry.
Return value		The created time entry

DeleteTimeEntries

Diese Methode löscht die übergebenen Zeiteinträge aus dem TimePunch Profil. Wichtig ist, dass nur die Zeiteinträge des authentifizierten TimePunch Profils gelöscht werden können.

void DeleteTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] timeEntryIds);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntryIds		Collection of time entry Ids that shall be deleted.

DeleteTimeEntriesInRange

Diese Methode löscht alle Zeiteinträge im übergebenen Zeitraum für die ausgewählten Mitarbeitenden.

void DeleteTimeEntriesInRange(
 out TpFault fault, 
 TpAuthentication authentication, 
 DateTime startDate, 
 DateTime endDate, 
 Guid[] userIds);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
DateTime	startDate	Start date to search for time entries
DateTime	endDate	End date to search for time entries
Guid[]	userIds	List of user ids that is used by the search

DeleteTimeEntryFilter

Diese Methode löscht einen Zeiteintrags-Filter.

TpFault DeleteTimeEntryFilter(  
 TpAuthentication authentication,  
 Guid filterId);

Needed Permission	timeEntryFilter@manage timeEntryFilter@managePublic
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
filterId		Id of the filter that shall be deleted
Return value		Fault object if an exception occurs

ImportTimeEntries

Diese Methode import die übergebenen Zeiteinträge. Beim Import werden nicht die IDs sondern die Start -und Endezeiten, sowie die Projekt -und Tätigkeitsnamen berücksichtigt.

void ImportTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<TimeEntryDto> rows);

Needed Permission	timeEntries@restrictedEdit commonTasks@manage projects@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
rows		Collection of time entries to import

LoadTimeEntries

Diese Methode sollte verwendet werden, wenn keine Zeiteinträge gesucht, sondern mit ihren Ids geladen werden sollen.

List<TimeEntryDto> LoadTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid[] timeEntryIds);

Needed Permission	timeEntries@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntryIds		Array of ids of the time entries that shall be loaded.
Return value		Returns the loaded time entries

LoadTimeEntryFilter

Diese Methode lädt einen Zeiteintragfilter mit der entsprechenden ID.

TimeEntrySearchDto LoadTimeEntryFilter(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid timeEntrySearchId);

Needed Permission	timeEntryFilter@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntrySearchId		Id of the time entry filter
Return value		Returns the loaded time entry filter

MarkTimeEntries

Diese Methode markiert die übergebenen Zeiteinträge mit dem entsprechenden Marker in TimePunch.

void MarkTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<Guid> selectedIds,  
 TimeEntryMarkAs markAs)

Needed Permission	timeEntries@restrictedEdit
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
selectedIds		List of time entry ids to mark
markAs		Marker that shall be set for the time entries Paid = 1 Important = 2 Onsite = 4

SaveTimeEntryFilter

Diese Methode speichert einen Zeiteintragsfilter in der Datenbank ab. Das Mapping erfolgt dabei nicht über die ID, sondern über den Namen des Berichtsfilters.

TimeEntrySearchDto SaveTimeEntryFilter(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySearchDto timeEntryFilter);

Needed Permission	timeEntryFilter@manage timeEntryFilter@managePublic
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntryFilter		Time Entry Filter so save
Return value		The stored time entry filter

SearchTimeEntries

Diese Methode sucht Zeiteinträge die dem angegebenen Filter Objekt entsprechen. Dabei wird die Rolle des Principal berücksichtigt und nur dann Daten von anderen TimePunch Profilen zurückgeliefert, wenn der Principal über die entsprechenden Rechte verfügt.

List<TimeEntryDto> SearchTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySearchDto search);

Needed Permission	timeEntries@access / core@switchIdentity
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
search		The filter that is used to search the time entries
Return value		Collection containing the found time entries

SearchTimeEntryFilters

Diese Methode sucht Zeiteintragsfilter in der Datenbank anhand der Suchfilter Kriterien. Es wird danach eine Liste mit allen gefunden Zeiteintragsfiltern zurückgeliefert.

List<TimeEntrySearchDto> SearchTimeEntryFilters(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntryFilterSearchDto searchFilterCriteria);

Needed Permission	timeEntryFilter@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
searchFilterCriteria		Searchfilter criteria
Return value		Collection containing the found time entry search objects

SplitTimeEntry

Diese Methode teilt einen bestehenden Zeiteintrag in mehrere Zeiteinträge auf.

void SplitTimeEntry(
 out TpFault fault, 
 TpAuthentication authentication, 
 Guid timeEntryId, 
 List<TimeEntrySaveDto> timeEntries, 
 bool closeActiveTimeEntry);

Needed Permission	timeEntries@restrictedEdit
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Guid	timeEntryId	ID of the time entry that shall be splitted. That can also be an ID of an active time entry.
TimeEntrySaveDto[]	timeEntries	List of time entries that shall replace the time entry specified by it's ID
bool	closeActiveTimeEntry	If the time entry Id specifies an active entry, this flag indicates whether to close the time recording or not

UnmarkTimeEntries

Diese Methode entfernt die Markierungen auf den übergebenen Zeiteinträgen.

void UnmarkTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 List<Guid> selectedIds,  
 TimeEntryMarkAs markAs);

Needed Permission	timeEntries@restrictedEdit
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
selectedIds		List of time entry ids to mark
markAs		Marker that shall be removed from the time entries Paid = 1 Important = 2 Onsite = 4

UpdateTimeEntryFilter

Diese Methode aktualisiert einen bestehenden Zeiteintragsfilter. Damit die Update Methode aufgerufen werden kann, sollte der zu aktualisierende Zeiteintragsfilter bereits vorhanden sein.

TimeEntrySearchDto UpdateTimeEntryFilter(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySearchDto filter);

Needed Permission	timeEntryFilter@manage timeEntryFilter@managePublic
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
filter		Time Entry Filter so save
Return value		The stored time entry filter

ValidateAndSaveBreakReplacement

Diese Methode wurde speziell dafür entwickelt auch von Mitarbeitern ohne besondere Rechte verwendet zu werden. Sie wird dazu verwendet, damit bereits vorhandene Pausen, d.h. die Zeit zwischen zwei Zeiteinträgen, von einem Mitarbeiter ohne besondere Rechte belegt werden kann.

TimeEntrySaveResultDto ValidateAndSaveBreakReplacement(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySaveDto timeEntry);

Needed Permission	timeEntries@restrictedEdit
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntry		Time entry that shall be stored in the database. The time entry must fit into a break time.
Return value		Returns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveRestrictedTimeEntry

Diese Methode dient zum eingeschränkten editieren eines Zeiteintrags. Diese Methode erlaubt nur das Bearbeiten des Projekts, der Tätigkeit und der Beschreibung. Start, und Endzeiten, sowie die Pause dürfen nicht geändert werden.

TimeEntrySaveResultDto ValidateAndSaveRestrictedTimeEntry(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntryRestrictedSaveDto timeEntry);

Needed Permission	timeEntries@restrictedEdit
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntry		Time entry that shall be stored in the database.
Return value		Returns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntry

Diese Methode nimmt einen Zeiteintrag entgegen, überprüft ihn auf Korrektheit und speichert dann den Zeiteintrag in der Datenbank ab.

TimeEntrySaveResultDto ValidateAndSaveTimeEntry(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySaveDto timeEntry);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntry		Time entry that shall be stored in the database.
Return value		Returns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntrySeries

Mit dieser Methode lässt sich eine Serie von Zeiteinträgen anlegen, zum Beispiel um eine Urlaubsbuchung zu realisieren. Benötigt wird das Start –und Enddatum. Die konkreten Anfangszeiten werden über das hinterlegte Arbeitszeitmodell ermittelt.

TimeEntrySaveResultDto ValidateAndSaveTimeEntrySeries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySeriesDto timeEntrySeries);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntrySeries		Time entry series that shall be stored in the database.
Return value		Returns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntrySeriesMultipleUsers

TimeEntrySaveResultDto ValidateAndSaveTimeEntrySeriesMultipleUsers(  
 out TpFault fault,  
 TpAuthentication authentication,  
 TimeEntrySeriesDto timeEntrySeries,
 Guid[] userIds);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntrySeries		Time entry series that shall be stored in the database.
Guid[]		Array of user ids for whom the time entry series shall be created
Return value		Returns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntryCopies

Mit dieser Methode lässt sich ein Zeiteintrag kopiert speichern, zum Beispiel um mehrere Tage hintereinander einen Arbeitszeiteintrag mit festgelegter Start –und Endzeit zu erstellen. Wie zum Beispiel für die Berufsschule benötigt.

TimeEntrySaveResultDto ValidateAndSaveTimeEntryCopies(  
 out TpFault fault,
 TpAuthentication authentication,
 TimeEntrySaveDto timeEntry);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntry		Time entry copy that shall be stored in the database.
Return value		Returns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntryCopiesMultipleUsers

TimeEntrySaveResultDto ValidateAndSaveTimeEntryCopiesMultipleUsers(  
 out TpFault fault,
 TpAuthentication authentication,
 TimeEntrySaveDto timeEntry,
 Guid[] userIds);

Needed Permission	timeEntries@manage
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntry		Time entry copy that shall be stored in the database.
Guid[]		Array of user ids for whom the time entry copies shall be created
Return value		Returns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

TimeEntry Service

AssignTimeEntriesToCustomer​

AssignTimeEntriesToProjects​

BatchFilterUpdate​

CheckTimeEntryOverlapping​

CopyTimeEntries​

CreateBreakTimeDummy​

CreateNewTimeEntry​

DeleteTimeEntries​

DeleteTimeEntriesInRange​

DeleteTimeEntryFilter​

ImportTimeEntries​

LoadTimeEntries​

LoadTimeEntryFilter​

MarkTimeEntries​

SaveTimeEntryFilter​

SearchTimeEntries​

SearchTimeEntryFilters​

SplitTimeEntry​

UnmarkTimeEntries​

UpdateTimeEntryFilter​

ValidateAndSaveBreakReplacement​

ValidateAndSaveRestrictedTimeEntry​

ValidateAndSaveTimeEntry​

ValidateAndSaveTimeEntrySeries​

ValidateAndSaveTimeEntrySeriesMultipleUsers​

ValidateAndSaveTimeEntryCopies​

ValidateAndSaveTimeEntryCopiesMultipleUsers​